Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[TT-9919] add docs for configuring cert-manager and webhooks #6054

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

[TT-9919] add docs for configuring cert-manager and webhooks #6054

wants to merge 5 commits into from

Conversation

olamilekan000
Copy link
Contributor

@olamilekan000 olamilekan000 commented Mar 4, 2025 •
edited by github-actions bot
Loading

User description

For internal users - Please add a Jira DX PR ticket to the subject!


Preview Link


Description

change documents how webhooks and cert-manger can be configured.

https://tyktech.atlassian.net/browse/TT-9919


Screenshots (if appropriate)


Checklist

  • I have added a preview link to the PR description.
  • I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
  • I have reviewed the guidelines for contributing to this repository.
  • I have read the technical guidelines for contributing to this repository.
  • Make sure you have started your change off our latest master.
  • For Tyk Members - Please add a Jira DX PR ticket to the subject!
  • For Tyk Members - I have added the appropriate release label to this PR:
    • If it is for a future release, label it as future-release and specify the version (e.g., future-release, 6.0).
    • If it should be merged into an older version, use the specific version label (e.g., 4.1, 5.1).
    • If no label is added, it will be assumed that the PR should be merged into the latest current version (e.g., 5.5) and master.

PR Type

Documentation

Description

  • Added Helm chart configuration docs for webhooks.

  • Detailed TLS settings using Cert-Manager.

Changes walkthrough 📝

Relevant files
Documentation
operator.md
Add webhooks configuration documentation in Helm Operator

tyk-docs/content/api-management/automations/operator.md

  • Inserted new "Webhooks" section in the operator file.
  • Provided Helm chart values snippet for enabling webhooks.
  • Documented TLS configuration with Cert-Manager.
    		• +20/-0   
    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    •

    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Mar 4, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Formatting

    Verify that the added code block for webhook configuration is rendered properly and consistently in the documentation.

     
    ##### Webhooks
Webhooks can now be configured using the Helm chart by specifying the necessary settings in the values.yaml file of the operator.

    webhooks:
    enabled: true
    port: 9443
    annotations: {}
    tls:
    useCertManager: true
    secretName: webhook-server-cert
    certificatesMountPath: "/tmp/k8s-webhook-server/serving-certs"

    Configuration Flexibility

    Consider making the cert-manager configuration more flexible instead of hardcoding tls.useCertManager to true, to align with the branch purpose.

     
    useCertManager: true

    @github-actions GitHub Actions
    Copy link
    Contributor

    github-actions bot commented Mar 4, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    add yaml language tag

    Include the YAML language identifier in the code block for better syntax
    highlighting.

    tyk-docs/content/api-management/automations/operator.md [5073-5074]

    -```
+```yaml
 webhooks:
    Suggestion importance[1-10]: 4

    __

    Why: The suggestion improves readability by specifying the YAML language for syntax highlighting, which is a minor but useful enhancement.

    		Low

    @netlify Netlify
    Copy link

    netlify bot commented Mar 4, 2025 •
    edited
    Loading

    ✅ PS. Pls add /docs/nightly to the end of url

    Name Link
    🔨 Latest commit a82bbd1
    🔍 Latest deploy log https://app.netlify.com/sites/tyk-docs/deploys/67d1babf9a7f6a000827e377
    😎 Deploy Preview https://deploy-preview-6054--tyk-docs.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @caroltyk
    Copy link
    Contributor

    caroltyk commented Mar 4, 2025

    @olamilekan000 we should update Operator Installation notes too.

    @sharadregoti sharadregoti changed the title add docs for configuring cert-manager and webhooks [TT-9919] add docs for configuring cert-manager and webhooks Mar 7, 2025
    @sharadregoti sharadregoti requested a review from caroltyk March 7, 2025 09:55
    sharadregoti
    sharadregoti requested changes Mar 7, 2025
    View reviewed changes
    tyk-docs/content/api-management/automations/operator.md Outdated
    Comment on lines 5070 to 5090
    ##### Webhooks
    Webhooks can now be configured using the Helm chart by specifying the necessary settings in the values.yaml file of the operator.

    ```
    webhooks:
    enabled: true
    port: 9443
    annotations: {}
    tls:
    useCertManager: true
    secretName: webhook-server-cert
    certificatesMountPath: "/tmp/k8s-webhook-server/serving-certs"
    ```
    - `enabled`: Enables or disables webhooks.
    - `port`: Specifies the port for webhook communication.
    - `annotations`: Allows adding custom annotations.
    - `tls.useCertManager`: If true, Cert-Manager will handle TLS certificates.
    - `tls.secretName`: The name of the Kubernetes Secret storing the TLS certificate.
    - `tls.certificatesMountPath`: Path where the webhook server mounts its certificates.
    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @caroltyk @olamilekan000 As per the Jira ticket, I think we need more description on webhooks and cert manager dependency.

    1. There will be changes in the installation section.
    2. Impact on previous version when upgrading.

    @olamilekan000 olamilekan000 force-pushed the TT-9919-allow-disabling-cert-manager branch from c5a65f3 to c30b0ad Compare March 11, 2025 09:18
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @caroltyk caroltyk Awaiting requested review from caroltyk

    @sharadregoti sharadregoti Awaiting requested review from sharadregoti

    Requested changes must be addressed to merge this pull request.

    Assignees
    No one assigned
    Labels
    5.8.0 Awaiting Peer Review Review effort 2/5 Tyk Operator 1.2
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @olamilekan000 @caroltyk @sharadregoti